<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<title>ConfigurationFactory xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/commons/configuration/ConfigurationFactory.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_comment"> * the License.  You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_comment"> *     <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_comment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="17" href="#17">17</a>  
<a class="jxr_linenumber" name="18" href="#18">18</a>  <strong class="jxr_keyword">package</strong> org.apache.commons.configuration;
<a class="jxr_linenumber" name="19" href="#19">19</a>  
<a class="jxr_linenumber" name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a class="jxr_linenumber" name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> java.net.URL;
<a class="jxr_linenumber" name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> java.util.Collection;
<a class="jxr_linenumber" name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> java.util.LinkedList;
<a class="jxr_linenumber" name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="27" href="#27">27</a>  
<a class="jxr_linenumber" name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.configuration.plist.PropertyListConfiguration;
<a class="jxr_linenumber" name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.configuration.plist.XMLPropertyListConfiguration;
<a class="jxr_linenumber" name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.digester.AbstractObjectCreationFactory;
<a class="jxr_linenumber" name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.digester.CallMethodRule;
<a class="jxr_linenumber" name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.digester.Digester;
<a class="jxr_linenumber" name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.digester.ObjectCreationFactory;
<a class="jxr_linenumber" name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.digester.Substitutor;
<a class="jxr_linenumber" name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.digester.substitution.MultiVariableExpander;
<a class="jxr_linenumber" name="36" href="#36">36</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.digester.substitution.VariableSubstitutor;
<a class="jxr_linenumber" name="37" href="#37">37</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.digester.xmlrules.DigesterLoader;
<a class="jxr_linenumber" name="38" href="#38">38</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.lang.StringUtils;
<a class="jxr_linenumber" name="39" href="#39">39</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.logging.Log;
<a class="jxr_linenumber" name="40" href="#40">40</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.logging.LogFactory;
<a class="jxr_linenumber" name="41" href="#41">41</a>  <strong class="jxr_keyword">import</strong> org.xml.sax.Attributes;
<a class="jxr_linenumber" name="42" href="#42">42</a>  <strong class="jxr_keyword">import</strong> org.xml.sax.SAXException;
<a class="jxr_linenumber" name="43" href="#43">43</a>  
<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> * Factory class to create a CompositeConfiguration from a .xml file using</em>
<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> * Digester.  By default it can handle the Configurations from commons-</em>
<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> * configuration.  If you need to add your own, then you can pass in your own</em>
<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> * digester rules to use.  It is also namespace aware, by providing a</em>
<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment"> * digesterRuleNamespaceURI.</em>
<a class="jxr_linenumber" name="51" href="#51">51</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> * &lt;em&gt;Note:&lt;/em&gt; Almost all of the features provided by this class and many</em>
<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment"> * more are also available for the {@link DefaultConfigurationBuilder}</em>
<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> * class. {@code DefaultConfigurationBuilder} also has a more robust</em>
<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment"> * merge algorithm for constructing combined configurations. So it is</em>
<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment"> * recommended to use this class instead of {@code ConfigurationFactory}.</em>
<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:epugh@upstate.com" target="alexandria_uri">mailto:epugh@upstate.com</a>"&gt;Eric Pugh&lt;/a&gt;</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:hps@intermeta.de" target="alexandria_uri">mailto:hps@intermeta.de</a>"&gt;Henning P. Schmiedehausen&lt;/a&gt;</em>
<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment"> * @version $Id: ConfigurationFactory.java 1209685 2011-12-02 20:47:44Z oheger $</em>
<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment"> * @deprecated Use {@link DefaultConfigurationBuilder} instead; this class</em>
<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment"> * provides the same features as ConfigurationFactory plus some more; it can</em>
<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment"> * also process the same configuration definition files.</em>
<a class="jxr_linenumber" name="66" href="#66">66</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="67" href="#67">67</a>  @Deprecated
<a class="jxr_linenumber" name="68" href="#68">68</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">ConfigurationFactory</a>
<a class="jxr_linenumber" name="69" href="#69">69</a>  {
<a class="jxr_linenumber" name="70" href="#70">70</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the root element in the info file.*/</em>
<a class="jxr_linenumber" name="71" href="#71">71</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SEC_ROOT = <span class="jxr_string">"configuration/"</span>;
<a class="jxr_linenumber" name="72" href="#72">72</a>  
<a class="jxr_linenumber" name="73" href="#73">73</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the override section.*/</em>
<a class="jxr_linenumber" name="74" href="#74">74</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SEC_OVERRIDE = SEC_ROOT + <span class="jxr_string">"override/"</span>;
<a class="jxr_linenumber" name="75" href="#75">75</a>  
<a class="jxr_linenumber" name="76" href="#76">76</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the additional section.*/</em>
<a class="jxr_linenumber" name="77" href="#77">77</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SEC_ADDITIONAL = SEC_ROOT + <span class="jxr_string">"additional/"</span>;
<a class="jxr_linenumber" name="78" href="#78">78</a>  
<a class="jxr_linenumber" name="79" href="#79">79</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the optional attribute.*/</em>
<a class="jxr_linenumber" name="80" href="#80">80</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ATTR_OPTIONAL = <span class="jxr_string">"optional"</span>;
<a class="jxr_linenumber" name="81" href="#81">81</a>  
<a class="jxr_linenumber" name="82" href="#82">82</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the fileName attribute.*/</em>
<a class="jxr_linenumber" name="83" href="#83">83</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ATTR_FILENAME = <span class="jxr_string">"fileName"</span>;
<a class="jxr_linenumber" name="84" href="#84">84</a>  
<a class="jxr_linenumber" name="85" href="#85">85</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the load method.*/</em>
<a class="jxr_linenumber" name="86" href="#86">86</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String METH_LOAD = <span class="jxr_string">"load"</span>;
<a class="jxr_linenumber" name="87" href="#87">87</a>  
<a class="jxr_linenumber" name="88" href="#88">88</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the default base path (points to actual directory).*/</em>
<a class="jxr_linenumber" name="89" href="#89">89</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEF_BASE_PATH = <span class="jxr_string">"."</span>;
<a class="jxr_linenumber" name="90" href="#90">90</a>  
<a class="jxr_linenumber" name="91" href="#91">91</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> static logger */</em>
<a class="jxr_linenumber" name="92" href="#92">92</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> Log log = LogFactory.getLog(ConfigurationFactory.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="93" href="#93">93</a>  
<a class="jxr_linenumber" name="94" href="#94">94</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The XML file with the details about the configuration to load */</em>
<a class="jxr_linenumber" name="95" href="#95">95</a>      <strong class="jxr_keyword">private</strong> String configurationFileName;
<a class="jxr_linenumber" name="96" href="#96">96</a>  
<a class="jxr_linenumber" name="97" href="#97">97</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The URL to the XML file with the details about the configuration to load. */</em>
<a class="jxr_linenumber" name="98" href="#98">98</a>      <strong class="jxr_keyword">private</strong> URL configurationURL;
<a class="jxr_linenumber" name="99" href="#99">99</a>  
<a class="jxr_linenumber" name="100" href="#100">100</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment">     * The implicit base path for included files. This path is determined by</em>
<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment">     * the configuration to load and used unless no other base path was</em>
<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment">     * explicitly specified.</em>
<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="105" href="#105">105</a>     <strong class="jxr_keyword">private</strong> String implicitBasePath;
<a class="jxr_linenumber" name="106" href="#106">106</a> 
<a class="jxr_linenumber" name="107" href="#107">107</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The basePath to prefix file paths for file based property files. */</em>
<a class="jxr_linenumber" name="108" href="#108">108</a>     <strong class="jxr_keyword">private</strong> String basePath;
<a class="jxr_linenumber" name="109" href="#109">109</a> 
<a class="jxr_linenumber" name="110" href="#110">110</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> URL for xml digester rules file */</em>
<a class="jxr_linenumber" name="111" href="#111">111</a>     <strong class="jxr_keyword">private</strong> URL digesterRules;
<a class="jxr_linenumber" name="112" href="#112">112</a> 
<a class="jxr_linenumber" name="113" href="#113">113</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The digester namespace to parse */</em>
<a class="jxr_linenumber" name="114" href="#114">114</a>     <strong class="jxr_keyword">private</strong> String digesterRuleNamespaceURI;
<a class="jxr_linenumber" name="115" href="#115">115</a> 
<a class="jxr_linenumber" name="116" href="#116">116</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment">     * Constructor</em>
<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="119" href="#119">119</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">ConfigurationFactory</a>()
<a class="jxr_linenumber" name="120" href="#120">120</a>     {
<a class="jxr_linenumber" name="121" href="#121">121</a>         setBasePath(DEF_BASE_PATH);
<a class="jxr_linenumber" name="122" href="#122">122</a>     }
<a class="jxr_linenumber" name="123" href="#123">123</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment">     * Constructor with ConfigurationFile Name passed</em>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment">     * @param configurationFileName The path to the configuration file</em>
<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="128" href="#128">128</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">ConfigurationFactory</a>(String configurationFileName)
<a class="jxr_linenumber" name="129" href="#129">129</a>     {
<a class="jxr_linenumber" name="130" href="#130">130</a>         setConfigurationFileName(configurationFileName);
<a class="jxr_linenumber" name="131" href="#131">131</a>     }
<a class="jxr_linenumber" name="132" href="#132">132</a> 
<a class="jxr_linenumber" name="133" href="#133">133</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment">     * Return the configuration provided by this factory. It loads the</em>
<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment">     * configuration file which is a XML description of the actual</em>
<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment">     * configurations to load. It can contain various different types of</em>
<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment">     * configuration, e.g. Properties, XML and JNDI.</em>
<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="139" href="#139">139</a> <em class="jxr_javadoccomment">     * @return A Configuration object</em>
<a class="jxr_linenumber" name="140" href="#140">140</a> <em class="jxr_javadoccomment">     * @throws ConfigurationException A generic exception that we had trouble during the</em>
<a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_javadoccomment">     * loading of the configuration data.</em>
<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="143" href="#143">143</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/Configuration.html">Configuration</a> getConfiguration() <strong class="jxr_keyword">throws</strong> ConfigurationException
<a class="jxr_linenumber" name="144" href="#144">144</a>     {
<a class="jxr_linenumber" name="145" href="#145">145</a>         Digester digester;
<a class="jxr_linenumber" name="146" href="#146">146</a>         InputStream input = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="147" href="#147">147</a>         <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">ConfigurationBuilder</a> builder = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">ConfigurationBuilder</a>();
<a class="jxr_linenumber" name="148" href="#148">148</a>         URL url = getConfigurationURL();
<a class="jxr_linenumber" name="149" href="#149">149</a>         <strong class="jxr_keyword">try</strong>
<a class="jxr_linenumber" name="150" href="#150">150</a>         {
<a class="jxr_linenumber" name="151" href="#151">151</a>             <strong class="jxr_keyword">if</strong> (url == <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="152" href="#152">152</a>             {
<a class="jxr_linenumber" name="153" href="#153">153</a>                 url = ConfigurationUtils.locate(implicitBasePath, getConfigurationFileName());
<a class="jxr_linenumber" name="154" href="#154">154</a>             }
<a class="jxr_linenumber" name="155" href="#155">155</a>             input = url.openStream();
<a class="jxr_linenumber" name="156" href="#156">156</a>         }
<a class="jxr_linenumber" name="157" href="#157">157</a>         <strong class="jxr_keyword">catch</strong> (Exception e)
<a class="jxr_linenumber" name="158" href="#158">158</a>         {
<a class="jxr_linenumber" name="159" href="#159">159</a>             log.error(<span class="jxr_string">"Exception caught opening stream to URL"</span>, e);
<a class="jxr_linenumber" name="160" href="#160">160</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationException.html">ConfigurationException</a>(<span class="jxr_string">"Exception caught opening stream to URL"</span>, e);
<a class="jxr_linenumber" name="161" href="#161">161</a>         }
<a class="jxr_linenumber" name="162" href="#162">162</a> 
<a class="jxr_linenumber" name="163" href="#163">163</a>         <strong class="jxr_keyword">if</strong> (getDigesterRules() == <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="164" href="#164">164</a>         {
<a class="jxr_linenumber" name="165" href="#165">165</a>             digester = <strong class="jxr_keyword">new</strong> Digester();
<a class="jxr_linenumber" name="166" href="#166">166</a>             configureNamespace(digester);
<a class="jxr_linenumber" name="167" href="#167">167</a>             initDefaultDigesterRules(digester);
<a class="jxr_linenumber" name="168" href="#168">168</a>         }
<a class="jxr_linenumber" name="169" href="#169">169</a>         <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="170" href="#170">170</a>         {
<a class="jxr_linenumber" name="171" href="#171">171</a>             digester = DigesterLoader.createDigester(getDigesterRules());
<a class="jxr_linenumber" name="172" href="#172">172</a>             <em class="jxr_comment">// This might already be too late. As far as I can see, the namespace</em>
<a class="jxr_linenumber" name="173" href="#173">173</a>             <em class="jxr_comment">// awareness must be configured before the digester rules are loaded.</em>
<a class="jxr_linenumber" name="174" href="#174">174</a>             configureNamespace(digester);
<a class="jxr_linenumber" name="175" href="#175">175</a>         }
<a class="jxr_linenumber" name="176" href="#176">176</a> 
<a class="jxr_linenumber" name="177" href="#177">177</a>         <em class="jxr_comment">// Configure digester to always enable the context class loader</em>
<a class="jxr_linenumber" name="178" href="#178">178</a>         digester.setUseContextClassLoader(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="179" href="#179">179</a>         <em class="jxr_comment">// Add a substitutor to resolve system properties</em>
<a class="jxr_linenumber" name="180" href="#180">180</a>         enableDigesterSubstitutor(digester);
<a class="jxr_linenumber" name="181" href="#181">181</a>         <em class="jxr_comment">// Put the composite builder object below all of the other objects.</em>
<a class="jxr_linenumber" name="182" href="#182">182</a>         digester.push(builder);
<a class="jxr_linenumber" name="183" href="#183">183</a>         <em class="jxr_comment">// Parse the input stream to configure our mappings</em>
<a class="jxr_linenumber" name="184" href="#184">184</a>         <strong class="jxr_keyword">try</strong>
<a class="jxr_linenumber" name="185" href="#185">185</a>         {
<a class="jxr_linenumber" name="186" href="#186">186</a>             digester.parse(input);
<a class="jxr_linenumber" name="187" href="#187">187</a>             input.close();
<a class="jxr_linenumber" name="188" href="#188">188</a>         }
<a class="jxr_linenumber" name="189" href="#189">189</a>         <strong class="jxr_keyword">catch</strong> (SAXException saxe)
<a class="jxr_linenumber" name="190" href="#190">190</a>         {
<a class="jxr_linenumber" name="191" href="#191">191</a>             log.error(<span class="jxr_string">"SAX Exception caught"</span>, saxe);
<a class="jxr_linenumber" name="192" href="#192">192</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationException.html">ConfigurationException</a>(<span class="jxr_string">"SAX Exception caught"</span>, saxe);
<a class="jxr_linenumber" name="193" href="#193">193</a>         }
<a class="jxr_linenumber" name="194" href="#194">194</a>         <strong class="jxr_keyword">catch</strong> (IOException ioe)
<a class="jxr_linenumber" name="195" href="#195">195</a>         {
<a class="jxr_linenumber" name="196" href="#196">196</a>             log.error(<span class="jxr_string">"IO Exception caught"</span>, ioe);
<a class="jxr_linenumber" name="197" href="#197">197</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationException.html">ConfigurationException</a>(<span class="jxr_string">"IO Exception caught"</span>, ioe);
<a class="jxr_linenumber" name="198" href="#198">198</a>         }
<a class="jxr_linenumber" name="199" href="#199">199</a>         <strong class="jxr_keyword">return</strong> builder.getConfiguration();
<a class="jxr_linenumber" name="200" href="#200">200</a>     }
<a class="jxr_linenumber" name="201" href="#201">201</a> 
<a class="jxr_linenumber" name="202" href="#202">202</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="203" href="#203">203</a> <em class="jxr_javadoccomment">     * Returns the configurationFile.</em>
<a class="jxr_linenumber" name="204" href="#204">204</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="205" href="#205">205</a> <em class="jxr_javadoccomment">     * @return The name of the configuration file. Can be null.</em>
<a class="jxr_linenumber" name="206" href="#206">206</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="207" href="#207">207</a>     <strong class="jxr_keyword">public</strong> String getConfigurationFileName()
<a class="jxr_linenumber" name="208" href="#208">208</a>     {
<a class="jxr_linenumber" name="209" href="#209">209</a>         <strong class="jxr_keyword">return</strong> configurationFileName;
<a class="jxr_linenumber" name="210" href="#210">210</a>     }
<a class="jxr_linenumber" name="211" href="#211">211</a> 
<a class="jxr_linenumber" name="212" href="#212">212</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="213" href="#213">213</a> <em class="jxr_javadoccomment">     * Sets the configurationFile.</em>
<a class="jxr_linenumber" name="214" href="#214">214</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="215" href="#215">215</a> <em class="jxr_javadoccomment">     * @param configurationFileName  The name of the configurationFile to use.</em>
<a class="jxr_linenumber" name="216" href="#216">216</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="217" href="#217">217</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setConfigurationFileName(String configurationFileName)
<a class="jxr_linenumber" name="218" href="#218">218</a>     {
<a class="jxr_linenumber" name="219" href="#219">219</a>         File file = <strong class="jxr_keyword">new</strong> File(configurationFileName).getAbsoluteFile();
<a class="jxr_linenumber" name="220" href="#220">220</a>         <strong class="jxr_keyword">this</strong>.configurationFileName = file.getName();
<a class="jxr_linenumber" name="221" href="#221">221</a>         implicitBasePath = file.getParent();
<a class="jxr_linenumber" name="222" href="#222">222</a>     }
<a class="jxr_linenumber" name="223" href="#223">223</a> 
<a class="jxr_linenumber" name="224" href="#224">224</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="225" href="#225">225</a> <em class="jxr_javadoccomment">     * Returns the URL of the configuration file to be loaded.</em>
<a class="jxr_linenumber" name="226" href="#226">226</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="227" href="#227">227</a> <em class="jxr_javadoccomment">     * @return the URL of the configuration to load</em>
<a class="jxr_linenumber" name="228" href="#228">228</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="229" href="#229">229</a>     <strong class="jxr_keyword">public</strong> URL getConfigurationURL()
<a class="jxr_linenumber" name="230" href="#230">230</a>     {
<a class="jxr_linenumber" name="231" href="#231">231</a>         <strong class="jxr_keyword">return</strong> configurationURL;
<a class="jxr_linenumber" name="232" href="#232">232</a>     }
<a class="jxr_linenumber" name="233" href="#233">233</a> 
<a class="jxr_linenumber" name="234" href="#234">234</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="235" href="#235">235</a> <em class="jxr_javadoccomment">     * Sets the URL of the configuration to load. This configuration can be</em>
<a class="jxr_linenumber" name="236" href="#236">236</a> <em class="jxr_javadoccomment">     * either specified by a file name or by a URL.</em>
<a class="jxr_linenumber" name="237" href="#237">237</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="238" href="#238">238</a> <em class="jxr_javadoccomment">     * @param url the URL of the configuration to load</em>
<a class="jxr_linenumber" name="239" href="#239">239</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="240" href="#240">240</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setConfigurationURL(URL url)
<a class="jxr_linenumber" name="241" href="#241">241</a>     {
<a class="jxr_linenumber" name="242" href="#242">242</a>         configurationURL = url;
<a class="jxr_linenumber" name="243" href="#243">243</a>         implicitBasePath = url.toString();
<a class="jxr_linenumber" name="244" href="#244">244</a>     }
<a class="jxr_linenumber" name="245" href="#245">245</a> 
<a class="jxr_linenumber" name="246" href="#246">246</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="247" href="#247">247</a> <em class="jxr_javadoccomment">     * Returns the digesterRules.</em>
<a class="jxr_linenumber" name="248" href="#248">248</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="249" href="#249">249</a> <em class="jxr_javadoccomment">     * @return URL</em>
<a class="jxr_linenumber" name="250" href="#250">250</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="251" href="#251">251</a>     <strong class="jxr_keyword">public</strong> URL getDigesterRules()
<a class="jxr_linenumber" name="252" href="#252">252</a>     {
<a class="jxr_linenumber" name="253" href="#253">253</a>         <strong class="jxr_keyword">return</strong> digesterRules;
<a class="jxr_linenumber" name="254" href="#254">254</a>     }
<a class="jxr_linenumber" name="255" href="#255">255</a> 
<a class="jxr_linenumber" name="256" href="#256">256</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="257" href="#257">257</a> <em class="jxr_javadoccomment">     * Sets the digesterRules.</em>
<a class="jxr_linenumber" name="258" href="#258">258</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="259" href="#259">259</a> <em class="jxr_javadoccomment">     * @param digesterRules The digesterRules to set</em>
<a class="jxr_linenumber" name="260" href="#260">260</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="261" href="#261">261</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDigesterRules(URL digesterRules)
<a class="jxr_linenumber" name="262" href="#262">262</a>     {
<a class="jxr_linenumber" name="263" href="#263">263</a>         <strong class="jxr_keyword">this</strong>.digesterRules = digesterRules;
<a class="jxr_linenumber" name="264" href="#264">264</a>     }
<a class="jxr_linenumber" name="265" href="#265">265</a> 
<a class="jxr_linenumber" name="266" href="#266">266</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="267" href="#267">267</a> <em class="jxr_javadoccomment">     * Adds a substitutor to interpolate system properties</em>
<a class="jxr_linenumber" name="268" href="#268">268</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="269" href="#269">269</a> <em class="jxr_javadoccomment">     * @param digester The digester to which we add the substitutor</em>
<a class="jxr_linenumber" name="270" href="#270">270</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="271" href="#271">271</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> enableDigesterSubstitutor(Digester digester)
<a class="jxr_linenumber" name="272" href="#272">272</a>     {
<a class="jxr_linenumber" name="273" href="#273">273</a>         <em class="jxr_comment">// This is ugly, but it is safe because the Properties object returned</em>
<a class="jxr_linenumber" name="274" href="#274">274</a>         <em class="jxr_comment">// by System.getProperties() (which is actually a Map&lt;Object, Object&gt;)</em>
<a class="jxr_linenumber" name="275" href="#275">275</a>         <em class="jxr_comment">// contains only String keys.</em>
<a class="jxr_linenumber" name="276" href="#276">276</a>         @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a class="jxr_linenumber" name="277" href="#277">277</a>         Map&lt;String, Object&gt; systemProperties =
<a class="jxr_linenumber" name="278" href="#278">278</a>                 (Map&lt;String, Object&gt;) (Object) System.getProperties();
<a class="jxr_linenumber" name="279" href="#279">279</a>         MultiVariableExpander expander = <strong class="jxr_keyword">new</strong> MultiVariableExpander();
<a class="jxr_linenumber" name="280" href="#280">280</a>         expander.addSource(<span class="jxr_string">"$"</span>, systemProperties);
<a class="jxr_linenumber" name="281" href="#281">281</a> 
<a class="jxr_linenumber" name="282" href="#282">282</a>         <em class="jxr_comment">// allow expansion in both xml attributes and element text</em>
<a class="jxr_linenumber" name="283" href="#283">283</a>         Substitutor substitutor = <strong class="jxr_keyword">new</strong> VariableSubstitutor(expander);
<a class="jxr_linenumber" name="284" href="#284">284</a>         digester.setSubstitutor(substitutor);
<a class="jxr_linenumber" name="285" href="#285">285</a>     }
<a class="jxr_linenumber" name="286" href="#286">286</a> 
<a class="jxr_linenumber" name="287" href="#287">287</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="288" href="#288">288</a> <em class="jxr_javadoccomment">     * Initializes the parsing rules for the default digester</em>
<a class="jxr_linenumber" name="289" href="#289">289</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="290" href="#290">290</a> <em class="jxr_javadoccomment">     * This allows the Configuration Factory to understand the default types:</em>
<a class="jxr_linenumber" name="291" href="#291">291</a> <em class="jxr_javadoccomment">     * Properties, XML and JNDI. Two special sections are introduced:</em>
<a class="jxr_linenumber" name="292" href="#292">292</a> <em class="jxr_javadoccomment">     * &lt;code&gt;&amp;lt;override&amp;gt;&lt;/code&gt; and &lt;code&gt;&amp;lt;additional&amp;gt;&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="293" href="#293">293</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="294" href="#294">294</a> <em class="jxr_javadoccomment">     * @param digester The digester to configure</em>
<a class="jxr_linenumber" name="295" href="#295">295</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="296" href="#296">296</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initDefaultDigesterRules(Digester digester)
<a class="jxr_linenumber" name="297" href="#297">297</a>     {
<a class="jxr_linenumber" name="298" href="#298">298</a>         initDigesterSectionRules(digester, SEC_ROOT, false);
<a class="jxr_linenumber" name="299" href="#299">299</a>         initDigesterSectionRules(digester, SEC_OVERRIDE, false);
<a class="jxr_linenumber" name="300" href="#300">300</a>         initDigesterSectionRules(digester, SEC_ADDITIONAL, <strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="301" href="#301">301</a>     }
<a class="jxr_linenumber" name="302" href="#302">302</a> 
<a class="jxr_linenumber" name="303" href="#303">303</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="304" href="#304">304</a> <em class="jxr_javadoccomment">     * Sets up digester rules for a specified section of the configuration</em>
<a class="jxr_linenumber" name="305" href="#305">305</a> <em class="jxr_javadoccomment">     * info file.</em>
<a class="jxr_linenumber" name="306" href="#306">306</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="307" href="#307">307</a> <em class="jxr_javadoccomment">     * @param digester the current digester instance</em>
<a class="jxr_linenumber" name="308" href="#308">308</a> <em class="jxr_javadoccomment">     * @param matchString specifies the section</em>
<a class="jxr_linenumber" name="309" href="#309">309</a> <em class="jxr_javadoccomment">     * @param additional a flag if rules for the additional section are to be</em>
<a class="jxr_linenumber" name="310" href="#310">310</a> <em class="jxr_javadoccomment">     * added</em>
<a class="jxr_linenumber" name="311" href="#311">311</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="312" href="#312">312</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initDigesterSectionRules(Digester digester, String matchString, <strong class="jxr_keyword">boolean</strong> additional)
<a class="jxr_linenumber" name="313" href="#313">313</a>     {
<a class="jxr_linenumber" name="314" href="#314">314</a>         setupDigesterInstance(
<a class="jxr_linenumber" name="315" href="#315">315</a>             digester,
<a class="jxr_linenumber" name="316" href="#316">316</a>             matchString + <span class="jxr_string">"properties"</span>,
<a class="jxr_linenumber" name="317" href="#317">317</a>             <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">PropertiesConfigurationFactory</a>(),
<a class="jxr_linenumber" name="318" href="#318">318</a>             METH_LOAD,
<a class="jxr_linenumber" name="319" href="#319">319</a>             additional);
<a class="jxr_linenumber" name="320" href="#320">320</a> 
<a class="jxr_linenumber" name="321" href="#321">321</a>         setupDigesterInstance(
<a class="jxr_linenumber" name="322" href="#322">322</a>             digester,
<a class="jxr_linenumber" name="323" href="#323">323</a>             matchString + <span class="jxr_string">"plist"</span>,
<a class="jxr_linenumber" name="324" href="#324">324</a>             <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">PropertyListConfigurationFactory</a>(),
<a class="jxr_linenumber" name="325" href="#325">325</a>             METH_LOAD,
<a class="jxr_linenumber" name="326" href="#326">326</a>             additional);
<a class="jxr_linenumber" name="327" href="#327">327</a> 
<a class="jxr_linenumber" name="328" href="#328">328</a>         setupDigesterInstance(
<a class="jxr_linenumber" name="329" href="#329">329</a>             digester,
<a class="jxr_linenumber" name="330" href="#330">330</a>             matchString + <span class="jxr_string">"xml"</span>,
<a class="jxr_linenumber" name="331" href="#331">331</a>             <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">FileConfigurationFactory</a>(XMLConfiguration.<strong class="jxr_keyword">class</strong>),
<a class="jxr_linenumber" name="332" href="#332">332</a>             METH_LOAD,
<a class="jxr_linenumber" name="333" href="#333">333</a>             additional);
<a class="jxr_linenumber" name="334" href="#334">334</a> 
<a class="jxr_linenumber" name="335" href="#335">335</a>         setupDigesterInstance(
<a class="jxr_linenumber" name="336" href="#336">336</a>             digester,
<a class="jxr_linenumber" name="337" href="#337">337</a>             matchString + <span class="jxr_string">"hierarchicalXml"</span>,
<a class="jxr_linenumber" name="338" href="#338">338</a>             <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">FileConfigurationFactory</a>(XMLConfiguration.<strong class="jxr_keyword">class</strong>),
<a class="jxr_linenumber" name="339" href="#339">339</a>             METH_LOAD,
<a class="jxr_linenumber" name="340" href="#340">340</a>             additional);
<a class="jxr_linenumber" name="341" href="#341">341</a> 
<a class="jxr_linenumber" name="342" href="#342">342</a>         setupDigesterInstance(
<a class="jxr_linenumber" name="343" href="#343">343</a>             digester,
<a class="jxr_linenumber" name="344" href="#344">344</a>             matchString + <span class="jxr_string">"jndi"</span>,
<a class="jxr_linenumber" name="345" href="#345">345</a>             <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">JNDIConfigurationFactory</a>(),
<a class="jxr_linenumber" name="346" href="#346">346</a>             <strong class="jxr_keyword">null</strong>,
<a class="jxr_linenumber" name="347" href="#347">347</a>             additional);
<a class="jxr_linenumber" name="348" href="#348">348</a> 
<a class="jxr_linenumber" name="349" href="#349">349</a>         setupDigesterInstance(
<a class="jxr_linenumber" name="350" href="#350">350</a>             digester,
<a class="jxr_linenumber" name="351" href="#351">351</a>             matchString + <span class="jxr_string">"system"</span>,
<a class="jxr_linenumber" name="352" href="#352">352</a>             <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">SystemConfigurationFactory</a>(),
<a class="jxr_linenumber" name="353" href="#353">353</a>             <strong class="jxr_keyword">null</strong>,
<a class="jxr_linenumber" name="354" href="#354">354</a>             additional);
<a class="jxr_linenumber" name="355" href="#355">355</a>     }
<a class="jxr_linenumber" name="356" href="#356">356</a> 
<a class="jxr_linenumber" name="357" href="#357">357</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="358" href="#358">358</a> <em class="jxr_javadoccomment">     * Sets up digester rules for a configuration to be loaded.</em>
<a class="jxr_linenumber" name="359" href="#359">359</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="360" href="#360">360</a> <em class="jxr_javadoccomment">     * @param digester the current digester</em>
<a class="jxr_linenumber" name="361" href="#361">361</a> <em class="jxr_javadoccomment">     * @param matchString the pattern to match with this rule</em>
<a class="jxr_linenumber" name="362" href="#362">362</a> <em class="jxr_javadoccomment">     * @param factory an ObjectCreationFactory instance to use for creating new</em>
<a class="jxr_linenumber" name="363" href="#363">363</a> <em class="jxr_javadoccomment">     * objects</em>
<a class="jxr_linenumber" name="364" href="#364">364</a> <em class="jxr_javadoccomment">     * @param method the name of a method to be called or &lt;b&gt;null&lt;/b&gt; for none</em>
<a class="jxr_linenumber" name="365" href="#365">365</a> <em class="jxr_javadoccomment">     * @param additional a flag if rules for the additional section are to be</em>
<a class="jxr_linenumber" name="366" href="#366">366</a> <em class="jxr_javadoccomment">     * added</em>
<a class="jxr_linenumber" name="367" href="#367">367</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="368" href="#368">368</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setupDigesterInstance(
<a class="jxr_linenumber" name="369" href="#369">369</a>             Digester digester,
<a class="jxr_linenumber" name="370" href="#370">370</a>             String matchString,
<a class="jxr_linenumber" name="371" href="#371">371</a>             ObjectCreationFactory factory,
<a class="jxr_linenumber" name="372" href="#372">372</a>             String method,
<a class="jxr_linenumber" name="373" href="#373">373</a>             <strong class="jxr_keyword">boolean</strong> additional)
<a class="jxr_linenumber" name="374" href="#374">374</a>     {
<a class="jxr_linenumber" name="375" href="#375">375</a>         <strong class="jxr_keyword">if</strong> (additional)
<a class="jxr_linenumber" name="376" href="#376">376</a>         {
<a class="jxr_linenumber" name="377" href="#377">377</a>             setupUnionRules(digester, matchString);
<a class="jxr_linenumber" name="378" href="#378">378</a>         }
<a class="jxr_linenumber" name="379" href="#379">379</a> 
<a class="jxr_linenumber" name="380" href="#380">380</a>         digester.addFactoryCreate(matchString, factory);
<a class="jxr_linenumber" name="381" href="#381">381</a>         digester.addSetProperties(matchString);
<a class="jxr_linenumber" name="382" href="#382">382</a> 
<a class="jxr_linenumber" name="383" href="#383">383</a>         <strong class="jxr_keyword">if</strong> (method != <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="384" href="#384">384</a>         {
<a class="jxr_linenumber" name="385" href="#385">385</a>             digester.addRule(matchString, <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">CallOptionalMethodRule</a>(method));
<a class="jxr_linenumber" name="386" href="#386">386</a>         }
<a class="jxr_linenumber" name="387" href="#387">387</a> 
<a class="jxr_linenumber" name="388" href="#388">388</a>         digester.addSetNext(matchString, <span class="jxr_string">"addConfiguration"</span>, Configuration.<strong class="jxr_keyword">class</strong>.getName());
<a class="jxr_linenumber" name="389" href="#389">389</a>     }
<a class="jxr_linenumber" name="390" href="#390">390</a> 
<a class="jxr_linenumber" name="391" href="#391">391</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="392" href="#392">392</a> <em class="jxr_javadoccomment">     * Sets up rules for configurations in the additional section.</em>
<a class="jxr_linenumber" name="393" href="#393">393</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="394" href="#394">394</a> <em class="jxr_javadoccomment">     * @param digester the current digester</em>
<a class="jxr_linenumber" name="395" href="#395">395</a> <em class="jxr_javadoccomment">     * @param matchString the pattern to match with this rule</em>
<a class="jxr_linenumber" name="396" href="#396">396</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="397" href="#397">397</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setupUnionRules(Digester digester, String matchString)
<a class="jxr_linenumber" name="398" href="#398">398</a>     {
<a class="jxr_linenumber" name="399" href="#399">399</a>         digester.addObjectCreate(matchString,
<a class="jxr_linenumber" name="400" href="#400">400</a>         AdditionalConfigurationData.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="401" href="#401">401</a>         digester.addSetProperties(matchString);
<a class="jxr_linenumber" name="402" href="#402">402</a>         digester.addSetNext(matchString, <span class="jxr_string">"addAdditionalConfig"</span>,
<a class="jxr_linenumber" name="403" href="#403">403</a>         AdditionalConfigurationData.<strong class="jxr_keyword">class</strong>.getName());
<a class="jxr_linenumber" name="404" href="#404">404</a>     }
<a class="jxr_linenumber" name="405" href="#405">405</a> 
<a class="jxr_linenumber" name="406" href="#406">406</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="407" href="#407">407</a> <em class="jxr_javadoccomment">     * Returns the digesterRuleNamespaceURI.</em>
<a class="jxr_linenumber" name="408" href="#408">408</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="409" href="#409">409</a> <em class="jxr_javadoccomment">     * @return A String with the digesterRuleNamespaceURI.</em>
<a class="jxr_linenumber" name="410" href="#410">410</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="411" href="#411">411</a>     <strong class="jxr_keyword">public</strong> String getDigesterRuleNamespaceURI()
<a class="jxr_linenumber" name="412" href="#412">412</a>     {
<a class="jxr_linenumber" name="413" href="#413">413</a>         <strong class="jxr_keyword">return</strong> digesterRuleNamespaceURI;
<a class="jxr_linenumber" name="414" href="#414">414</a>     }
<a class="jxr_linenumber" name="415" href="#415">415</a> 
<a class="jxr_linenumber" name="416" href="#416">416</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="417" href="#417">417</a> <em class="jxr_javadoccomment">     * Sets the digesterRuleNamespaceURI.</em>
<a class="jxr_linenumber" name="418" href="#418">418</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="419" href="#419">419</a> <em class="jxr_javadoccomment">     * @param digesterRuleNamespaceURI The new digesterRuleNamespaceURI to use</em>
<a class="jxr_linenumber" name="420" href="#420">420</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="421" href="#421">421</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDigesterRuleNamespaceURI(String digesterRuleNamespaceURI)
<a class="jxr_linenumber" name="422" href="#422">422</a>     {
<a class="jxr_linenumber" name="423" href="#423">423</a>         <strong class="jxr_keyword">this</strong>.digesterRuleNamespaceURI = digesterRuleNamespaceURI;
<a class="jxr_linenumber" name="424" href="#424">424</a>     }
<a class="jxr_linenumber" name="425" href="#425">425</a> 
<a class="jxr_linenumber" name="426" href="#426">426</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="427" href="#427">427</a> <em class="jxr_javadoccomment">     * Configure the current digester to be namespace aware and to have</em>
<a class="jxr_linenumber" name="428" href="#428">428</a> <em class="jxr_javadoccomment">     * a Configuration object to which all of the other configurations</em>
<a class="jxr_linenumber" name="429" href="#429">429</a> <em class="jxr_javadoccomment">     * should be added</em>
<a class="jxr_linenumber" name="430" href="#430">430</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="431" href="#431">431</a> <em class="jxr_javadoccomment">     * @param digester The Digester to configure</em>
<a class="jxr_linenumber" name="432" href="#432">432</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="433" href="#433">433</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> configureNamespace(Digester digester)
<a class="jxr_linenumber" name="434" href="#434">434</a>     {
<a class="jxr_linenumber" name="435" href="#435">435</a>         <strong class="jxr_keyword">if</strong> (getDigesterRuleNamespaceURI() != <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="436" href="#436">436</a>         {
<a class="jxr_linenumber" name="437" href="#437">437</a>             digester.setNamespaceAware(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="438" href="#438">438</a>             digester.setRuleNamespaceURI(getDigesterRuleNamespaceURI());
<a class="jxr_linenumber" name="439" href="#439">439</a>         }
<a class="jxr_linenumber" name="440" href="#440">440</a>         <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="441" href="#441">441</a>         {
<a class="jxr_linenumber" name="442" href="#442">442</a>             digester.setNamespaceAware(false);
<a class="jxr_linenumber" name="443" href="#443">443</a>         }
<a class="jxr_linenumber" name="444" href="#444">444</a>         digester.setValidating(false);
<a class="jxr_linenumber" name="445" href="#445">445</a>     }
<a class="jxr_linenumber" name="446" href="#446">446</a> 
<a class="jxr_linenumber" name="447" href="#447">447</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="448" href="#448">448</a> <em class="jxr_javadoccomment">     * Returns the Base path from which this Configuration Factory operates.</em>
<a class="jxr_linenumber" name="449" href="#449">449</a> <em class="jxr_javadoccomment">     * This is never null. If you set the BasePath to null, then a base path</em>
<a class="jxr_linenumber" name="450" href="#450">450</a> <em class="jxr_javadoccomment">     * according to the configuration to load is returned.</em>
<a class="jxr_linenumber" name="451" href="#451">451</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="452" href="#452">452</a> <em class="jxr_javadoccomment">     * @return The base Path of this configuration factory.</em>
<a class="jxr_linenumber" name="453" href="#453">453</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="454" href="#454">454</a>     <strong class="jxr_keyword">public</strong> String getBasePath()
<a class="jxr_linenumber" name="455" href="#455">455</a>     {
<a class="jxr_linenumber" name="456" href="#456">456</a>         String path = StringUtils.isEmpty(basePath)
<a class="jxr_linenumber" name="457" href="#457">457</a>                 || DEF_BASE_PATH.equals(basePath) ? implicitBasePath : basePath;
<a class="jxr_linenumber" name="458" href="#458">458</a>         <strong class="jxr_keyword">return</strong> StringUtils.isEmpty(path) ? DEF_BASE_PATH : path;
<a class="jxr_linenumber" name="459" href="#459">459</a>     }
<a class="jxr_linenumber" name="460" href="#460">460</a> 
<a class="jxr_linenumber" name="461" href="#461">461</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="462" href="#462">462</a> <em class="jxr_javadoccomment">     * Sets the basePath for all file references from this Configuration Factory.</em>
<a class="jxr_linenumber" name="463" href="#463">463</a> <em class="jxr_javadoccomment">     * Normally a base path need not to be set because it is determined by</em>
<a class="jxr_linenumber" name="464" href="#464">464</a> <em class="jxr_javadoccomment">     * the location of the configuration file to load. All relative pathes in</em>
<a class="jxr_linenumber" name="465" href="#465">465</a> <em class="jxr_javadoccomment">     * this file are resolved relative to this file. Setting a base path makes</em>
<a class="jxr_linenumber" name="466" href="#466">466</a> <em class="jxr_javadoccomment">     * sense if such relative pathes should be otherwise resolved, e.g. if</em>
<a class="jxr_linenumber" name="467" href="#467">467</a> <em class="jxr_javadoccomment">     * the configuration file is loaded from the class path and all sub</em>
<a class="jxr_linenumber" name="468" href="#468">468</a> <em class="jxr_javadoccomment">     * configurations it refers to are stored in a special config directory.</em>
<a class="jxr_linenumber" name="469" href="#469">469</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="470" href="#470">470</a> <em class="jxr_javadoccomment">     * @param basePath The new basePath to set.</em>
<a class="jxr_linenumber" name="471" href="#471">471</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="472" href="#472">472</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setBasePath(String basePath)
<a class="jxr_linenumber" name="473" href="#473">473</a>     {
<a class="jxr_linenumber" name="474" href="#474">474</a>         <strong class="jxr_keyword">this</strong>.basePath = basePath;
<a class="jxr_linenumber" name="475" href="#475">475</a>     }
<a class="jxr_linenumber" name="476" href="#476">476</a> 
<a class="jxr_linenumber" name="477" href="#477">477</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="478" href="#478">478</a> <em class="jxr_javadoccomment">     * A base class for digester factory classes. This base class maintains</em>
<a class="jxr_linenumber" name="479" href="#479">479</a> <em class="jxr_javadoccomment">     * a default class for the objects to be created.</em>
<a class="jxr_linenumber" name="480" href="#480">480</a> <em class="jxr_javadoccomment">     * There will be sub classes for specific configuration implementations.</em>
<a class="jxr_linenumber" name="481" href="#481">481</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="482" href="#482">482</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">DigesterConfigurationFactory</a> <strong class="jxr_keyword">extends</strong> AbstractObjectCreationFactory
<a class="jxr_linenumber" name="483" href="#483">483</a>     {
<a class="jxr_linenumber" name="484" href="#484">484</a>         <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Actual class to use. */</em>
<a class="jxr_linenumber" name="485" href="#485">485</a>         <strong class="jxr_keyword">private</strong> Class&lt;?&gt; clazz;
<a class="jxr_linenumber" name="486" href="#486">486</a> 
<a class="jxr_linenumber" name="487" href="#487">487</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="488" href="#488">488</a> <em class="jxr_javadoccomment">         * Creates a new instance of {@code DigesterConfigurationFactory}.</em>
<a class="jxr_linenumber" name="489" href="#489">489</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="490" href="#490">490</a> <em class="jxr_javadoccomment">         * @param clazz the class which we should instantiate</em>
<a class="jxr_linenumber" name="491" href="#491">491</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="492" href="#492">492</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">DigesterConfigurationFactory</a>(Class&lt;?&gt; clazz)
<a class="jxr_linenumber" name="493" href="#493">493</a>         {
<a class="jxr_linenumber" name="494" href="#494">494</a>             <strong class="jxr_keyword">this</strong>.clazz = clazz;
<a class="jxr_linenumber" name="495" href="#495">495</a>         }
<a class="jxr_linenumber" name="496" href="#496">496</a> 
<a class="jxr_linenumber" name="497" href="#497">497</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="498" href="#498">498</a> <em class="jxr_javadoccomment">         * Creates an instance of the specified class.</em>
<a class="jxr_linenumber" name="499" href="#499">499</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="500" href="#500">500</a> <em class="jxr_javadoccomment">         * @param attribs the attributes (ignored)</em>
<a class="jxr_linenumber" name="501" href="#501">501</a> <em class="jxr_javadoccomment">         * @return the new object</em>
<a class="jxr_linenumber" name="502" href="#502">502</a> <em class="jxr_javadoccomment">         * @throws Exception if object creation fails</em>
<a class="jxr_linenumber" name="503" href="#503">503</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="504" href="#504">504</a>         @Override
<a class="jxr_linenumber" name="505" href="#505">505</a>         <strong class="jxr_keyword">public</strong> Object createObject(Attributes attribs) <strong class="jxr_keyword">throws</strong> Exception
<a class="jxr_linenumber" name="506" href="#506">506</a>         {
<a class="jxr_linenumber" name="507" href="#507">507</a>             <strong class="jxr_keyword">return</strong> clazz.newInstance();
<a class="jxr_linenumber" name="508" href="#508">508</a>         }
<a class="jxr_linenumber" name="509" href="#509">509</a>     }
<a class="jxr_linenumber" name="510" href="#510">510</a> 
<a class="jxr_linenumber" name="511" href="#511">511</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="512" href="#512">512</a> <em class="jxr_javadoccomment">     * A tiny inner class that allows the Configuration Factory to</em>
<a class="jxr_linenumber" name="513" href="#513">513</a> <em class="jxr_javadoccomment">     * let the digester construct FileConfiguration objects</em>
<a class="jxr_linenumber" name="514" href="#514">514</a> <em class="jxr_javadoccomment">     * that already have the correct base Path set.</em>
<a class="jxr_linenumber" name="515" href="#515">515</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="516" href="#516">516</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="517" href="#517">517</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">FileConfigurationFactory</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">DigesterConfigurationFactory</a>
<a class="jxr_linenumber" name="518" href="#518">518</a>     {
<a class="jxr_linenumber" name="519" href="#519">519</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="520" href="#520">520</a> <em class="jxr_javadoccomment">         * C'tor</em>
<a class="jxr_linenumber" name="521" href="#521">521</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="522" href="#522">522</a> <em class="jxr_javadoccomment">         * @param clazz The class which we should instantiate.</em>
<a class="jxr_linenumber" name="523" href="#523">523</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="524" href="#524">524</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">FileConfigurationFactory</a>(Class&lt;?&gt; clazz)
<a class="jxr_linenumber" name="525" href="#525">525</a>         {
<a class="jxr_linenumber" name="526" href="#526">526</a>             <strong class="jxr_keyword">super</strong>(clazz);
<a class="jxr_linenumber" name="527" href="#527">527</a>         }
<a class="jxr_linenumber" name="528" href="#528">528</a> 
<a class="jxr_linenumber" name="529" href="#529">529</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="530" href="#530">530</a> <em class="jxr_javadoccomment">         * Gets called by the digester.</em>
<a class="jxr_linenumber" name="531" href="#531">531</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="532" href="#532">532</a> <em class="jxr_javadoccomment">         * @param attributes the actual attributes</em>
<a class="jxr_linenumber" name="533" href="#533">533</a> <em class="jxr_javadoccomment">         * @return the new object</em>
<a class="jxr_linenumber" name="534" href="#534">534</a> <em class="jxr_javadoccomment">         * @throws Exception Couldn't instantiate the requested object.</em>
<a class="jxr_linenumber" name="535" href="#535">535</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="536" href="#536">536</a>         @Override
<a class="jxr_linenumber" name="537" href="#537">537</a>         <strong class="jxr_keyword">public</strong> Object createObject(Attributes attributes) <strong class="jxr_keyword">throws</strong> Exception
<a class="jxr_linenumber" name="538" href="#538">538</a>         {
<a class="jxr_linenumber" name="539" href="#539">539</a>             <a href="../../../../org/apache/commons/configuration/FileConfiguration.html">FileConfiguration</a> conf = createConfiguration(attributes);
<a class="jxr_linenumber" name="540" href="#540">540</a>             conf.setBasePath(getBasePath());
<a class="jxr_linenumber" name="541" href="#541">541</a>             <strong class="jxr_keyword">return</strong> conf;
<a class="jxr_linenumber" name="542" href="#542">542</a>         }
<a class="jxr_linenumber" name="543" href="#543">543</a> 
<a class="jxr_linenumber" name="544" href="#544">544</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="545" href="#545">545</a> <em class="jxr_javadoccomment">         * Creates the object, a {@code FileConfiguration}.</em>
<a class="jxr_linenumber" name="546" href="#546">546</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="547" href="#547">547</a> <em class="jxr_javadoccomment">         * @param attributes the actual attributes</em>
<a class="jxr_linenumber" name="548" href="#548">548</a> <em class="jxr_javadoccomment">         * @return the file configuration</em>
<a class="jxr_linenumber" name="549" href="#549">549</a> <em class="jxr_javadoccomment">         * @throws Exception if the object could not be created</em>
<a class="jxr_linenumber" name="550" href="#550">550</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="551" href="#551">551</a>         <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/commons/configuration/FileConfiguration.html">FileConfiguration</a> createConfiguration(Attributes attributes) <strong class="jxr_keyword">throws</strong> Exception
<a class="jxr_linenumber" name="552" href="#552">552</a>         {
<a class="jxr_linenumber" name="553" href="#553">553</a>             <strong class="jxr_keyword">return</strong> (FileConfiguration) <strong class="jxr_keyword">super</strong>.createObject(attributes);
<a class="jxr_linenumber" name="554" href="#554">554</a>         }
<a class="jxr_linenumber" name="555" href="#555">555</a>     }
<a class="jxr_linenumber" name="556" href="#556">556</a> 
<a class="jxr_linenumber" name="557" href="#557">557</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="558" href="#558">558</a> <em class="jxr_javadoccomment">     * A factory that returns an XMLPropertiesConfiguration for .xml files</em>
<a class="jxr_linenumber" name="559" href="#559">559</a> <em class="jxr_javadoccomment">     * and a PropertiesConfiguration for the others.</em>
<a class="jxr_linenumber" name="560" href="#560">560</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="561" href="#561">561</a> <em class="jxr_javadoccomment">     * @since 1.2</em>
<a class="jxr_linenumber" name="562" href="#562">562</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="563" href="#563">563</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">PropertiesConfigurationFactory</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">FileConfigurationFactory</a>
<a class="jxr_linenumber" name="564" href="#564">564</a>     {
<a class="jxr_linenumber" name="565" href="#565">565</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="566" href="#566">566</a> <em class="jxr_javadoccomment">         * Creates a new instance of {@code PropertiesConfigurationFactory}.</em>
<a class="jxr_linenumber" name="567" href="#567">567</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="568" href="#568">568</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">PropertiesConfigurationFactory</a>()
<a class="jxr_linenumber" name="569" href="#569">569</a>         {
<a class="jxr_linenumber" name="570" href="#570">570</a>             <strong class="jxr_keyword">super</strong>(<strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="571" href="#571">571</a>         }
<a class="jxr_linenumber" name="572" href="#572">572</a> 
<a class="jxr_linenumber" name="573" href="#573">573</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="574" href="#574">574</a> <em class="jxr_javadoccomment">         * Creates the new configuration object. Based on the file name</em>
<a class="jxr_linenumber" name="575" href="#575">575</a> <em class="jxr_javadoccomment">         * provided in the attributes either a {@code PropertiesConfiguration}</em>
<a class="jxr_linenumber" name="576" href="#576">576</a> <em class="jxr_javadoccomment">         * or a {@code XMLPropertiesConfiguration} object will be</em>
<a class="jxr_linenumber" name="577" href="#577">577</a> <em class="jxr_javadoccomment">         * returned.</em>
<a class="jxr_linenumber" name="578" href="#578">578</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="579" href="#579">579</a> <em class="jxr_javadoccomment">         * @param attributes the attributes</em>
<a class="jxr_linenumber" name="580" href="#580">580</a> <em class="jxr_javadoccomment">         * @return the new configuration object</em>
<a class="jxr_linenumber" name="581" href="#581">581</a> <em class="jxr_javadoccomment">         * @throws Exception if an error occurs</em>
<a class="jxr_linenumber" name="582" href="#582">582</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="583" href="#583">583</a>         @Override
<a class="jxr_linenumber" name="584" href="#584">584</a>         <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/commons/configuration/FileConfiguration.html">FileConfiguration</a> createConfiguration(Attributes attributes) <strong class="jxr_keyword">throws</strong> Exception
<a class="jxr_linenumber" name="585" href="#585">585</a>         {
<a class="jxr_linenumber" name="586" href="#586">586</a>             String filename = attributes.getValue(ATTR_FILENAME);
<a class="jxr_linenumber" name="587" href="#587">587</a> 
<a class="jxr_linenumber" name="588" href="#588">588</a>             <strong class="jxr_keyword">if</strong> (filename != <strong class="jxr_keyword">null</strong> &amp;&amp; filename.toLowerCase().trim().endsWith(<span class="jxr_string">".xml"</span>))
<a class="jxr_linenumber" name="589" href="#589">589</a>             {
<a class="jxr_linenumber" name="590" href="#590">590</a>                 <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/XMLPropertiesConfiguration.html">XMLPropertiesConfiguration</a>();
<a class="jxr_linenumber" name="591" href="#591">591</a>             }
<a class="jxr_linenumber" name="592" href="#592">592</a>             <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="593" href="#593">593</a>             {
<a class="jxr_linenumber" name="594" href="#594">594</a>                 <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/PropertiesConfiguration.html">PropertiesConfiguration</a>();
<a class="jxr_linenumber" name="595" href="#595">595</a>             }
<a class="jxr_linenumber" name="596" href="#596">596</a>         }
<a class="jxr_linenumber" name="597" href="#597">597</a>     }
<a class="jxr_linenumber" name="598" href="#598">598</a> 
<a class="jxr_linenumber" name="599" href="#599">599</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="600" href="#600">600</a> <em class="jxr_javadoccomment">     * A factory that returns an XMLPropertyListConfiguration for .xml files</em>
<a class="jxr_linenumber" name="601" href="#601">601</a> <em class="jxr_javadoccomment">     * and a PropertyListConfiguration for the others.</em>
<a class="jxr_linenumber" name="602" href="#602">602</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="603" href="#603">603</a> <em class="jxr_javadoccomment">     * @since 1.2</em>
<a class="jxr_linenumber" name="604" href="#604">604</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="605" href="#605">605</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">PropertyListConfigurationFactory</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">FileConfigurationFactory</a>
<a class="jxr_linenumber" name="606" href="#606">606</a>     {
<a class="jxr_linenumber" name="607" href="#607">607</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="608" href="#608">608</a> <em class="jxr_javadoccomment">         * Creates a new instance of PropertyListConfigurationFactory&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="609" href="#609">609</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="610" href="#610">610</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">PropertyListConfigurationFactory</a>()
<a class="jxr_linenumber" name="611" href="#611">611</a>         {
<a class="jxr_linenumber" name="612" href="#612">612</a>             <strong class="jxr_keyword">super</strong>(<strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="613" href="#613">613</a>         }
<a class="jxr_linenumber" name="614" href="#614">614</a> 
<a class="jxr_linenumber" name="615" href="#615">615</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="616" href="#616">616</a> <em class="jxr_javadoccomment">         * Creates the new configuration object. Based on the file name</em>
<a class="jxr_linenumber" name="617" href="#617">617</a> <em class="jxr_javadoccomment">         * provided in the attributes either a {@code XMLPropertyListConfiguration}</em>
<a class="jxr_linenumber" name="618" href="#618">618</a> <em class="jxr_javadoccomment">         * or a {@code PropertyListConfiguration} object will be</em>
<a class="jxr_linenumber" name="619" href="#619">619</a> <em class="jxr_javadoccomment">         * returned.</em>
<a class="jxr_linenumber" name="620" href="#620">620</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="621" href="#621">621</a> <em class="jxr_javadoccomment">         * @param attributes the attributes</em>
<a class="jxr_linenumber" name="622" href="#622">622</a> <em class="jxr_javadoccomment">         * @return the new configuration object</em>
<a class="jxr_linenumber" name="623" href="#623">623</a> <em class="jxr_javadoccomment">         * @throws Exception if an error occurs</em>
<a class="jxr_linenumber" name="624" href="#624">624</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="625" href="#625">625</a>         @Override
<a class="jxr_linenumber" name="626" href="#626">626</a>         <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/commons/configuration/FileConfiguration.html">FileConfiguration</a> createConfiguration(Attributes attributes) <strong class="jxr_keyword">throws</strong> Exception
<a class="jxr_linenumber" name="627" href="#627">627</a>         {
<a class="jxr_linenumber" name="628" href="#628">628</a>             String filename = attributes.getValue(ATTR_FILENAME);
<a class="jxr_linenumber" name="629" href="#629">629</a> 
<a class="jxr_linenumber" name="630" href="#630">630</a>             <strong class="jxr_keyword">if</strong> (filename != <strong class="jxr_keyword">null</strong> &amp;&amp; filename.toLowerCase().trim().endsWith(<span class="jxr_string">".xml"</span>))
<a class="jxr_linenumber" name="631" href="#631">631</a>             {
<a class="jxr_linenumber" name="632" href="#632">632</a>                 <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/plist/XMLPropertyListConfiguration.html">XMLPropertyListConfiguration</a>();
<a class="jxr_linenumber" name="633" href="#633">633</a>             }
<a class="jxr_linenumber" name="634" href="#634">634</a>             <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="635" href="#635">635</a>             {
<a class="jxr_linenumber" name="636" href="#636">636</a>                 <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/plist/PropertyListConfiguration.html">PropertyListConfiguration</a>();
<a class="jxr_linenumber" name="637" href="#637">637</a>             }
<a class="jxr_linenumber" name="638" href="#638">638</a>         }
<a class="jxr_linenumber" name="639" href="#639">639</a>     }
<a class="jxr_linenumber" name="640" href="#640">640</a> 
<a class="jxr_linenumber" name="641" href="#641">641</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="642" href="#642">642</a> <em class="jxr_javadoccomment">     * A tiny inner class that allows the Configuration Factory to</em>
<a class="jxr_linenumber" name="643" href="#643">643</a> <em class="jxr_javadoccomment">     * let the digester construct JNDIConfiguration objects.</em>
<a class="jxr_linenumber" name="644" href="#644">644</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="645" href="#645">645</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">JNDIConfigurationFactory</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">DigesterConfigurationFactory</a>
<a class="jxr_linenumber" name="646" href="#646">646</a>     {
<a class="jxr_linenumber" name="647" href="#647">647</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="648" href="#648">648</a> <em class="jxr_javadoccomment">         * Creates a new instance of {@code JNDIConfigurationFactory}.</em>
<a class="jxr_linenumber" name="649" href="#649">649</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="650" href="#650">650</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">JNDIConfigurationFactory</a>()
<a class="jxr_linenumber" name="651" href="#651">651</a>         {
<a class="jxr_linenumber" name="652" href="#652">652</a>             <strong class="jxr_keyword">super</strong>(JNDIConfiguration.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="653" href="#653">653</a>         }
<a class="jxr_linenumber" name="654" href="#654">654</a>     }
<a class="jxr_linenumber" name="655" href="#655">655</a> 
<a class="jxr_linenumber" name="656" href="#656">656</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="657" href="#657">657</a> <em class="jxr_javadoccomment">     * A tiny inner class that allows the Configuration Factory to</em>
<a class="jxr_linenumber" name="658" href="#658">658</a> <em class="jxr_javadoccomment">     * let the digester construct SystemConfiguration objects.</em>
<a class="jxr_linenumber" name="659" href="#659">659</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="660" href="#660">660</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">SystemConfigurationFactory</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">DigesterConfigurationFactory</a>
<a class="jxr_linenumber" name="661" href="#661">661</a>     {
<a class="jxr_linenumber" name="662" href="#662">662</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="663" href="#663">663</a> <em class="jxr_javadoccomment">         * Creates a new instance of {@code SystemConfigurationFactory}.</em>
<a class="jxr_linenumber" name="664" href="#664">664</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="665" href="#665">665</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">SystemConfigurationFactory</a>()
<a class="jxr_linenumber" name="666" href="#666">666</a>         {
<a class="jxr_linenumber" name="667" href="#667">667</a>             <strong class="jxr_keyword">super</strong>(SystemConfiguration.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="668" href="#668">668</a>         }
<a class="jxr_linenumber" name="669" href="#669">669</a>     }
<a class="jxr_linenumber" name="670" href="#670">670</a> 
<a class="jxr_linenumber" name="671" href="#671">671</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="672" href="#672">672</a> <em class="jxr_javadoccomment">     * A simple data class that holds all information about a configuration</em>
<a class="jxr_linenumber" name="673" href="#673">673</a> <em class="jxr_javadoccomment">     * from the &lt;code&gt;&amp;lt;additional&amp;gt;&lt;/code&gt; section.</em>
<a class="jxr_linenumber" name="674" href="#674">674</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="675" href="#675">675</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">AdditionalConfigurationData</a>
<a class="jxr_linenumber" name="676" href="#676">676</a>     {
<a class="jxr_linenumber" name="677" href="#677">677</a>         <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Stores the configuration object.*/</em>
<a class="jxr_linenumber" name="678" href="#678">678</a>         <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/commons/configuration/Configuration.html">Configuration</a> configuration;
<a class="jxr_linenumber" name="679" href="#679">679</a> 
<a class="jxr_linenumber" name="680" href="#680">680</a>         <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Stores the location of this configuration in the global tree.*/</em>
<a class="jxr_linenumber" name="681" href="#681">681</a>         <strong class="jxr_keyword">private</strong> String at;
<a class="jxr_linenumber" name="682" href="#682">682</a> 
<a class="jxr_linenumber" name="683" href="#683">683</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="684" href="#684">684</a> <em class="jxr_javadoccomment">         * Returns the value of the {@code at} attribute.</em>
<a class="jxr_linenumber" name="685" href="#685">685</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="686" href="#686">686</a> <em class="jxr_javadoccomment">         * @return the at attribute</em>
<a class="jxr_linenumber" name="687" href="#687">687</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="688" href="#688">688</a>         <strong class="jxr_keyword">public</strong> String getAt()
<a class="jxr_linenumber" name="689" href="#689">689</a>         {
<a class="jxr_linenumber" name="690" href="#690">690</a>             <strong class="jxr_keyword">return</strong> at;
<a class="jxr_linenumber" name="691" href="#691">691</a>         }
<a class="jxr_linenumber" name="692" href="#692">692</a> 
<a class="jxr_linenumber" name="693" href="#693">693</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="694" href="#694">694</a> <em class="jxr_javadoccomment">         * Sets the value of the {@code at} attribute.</em>
<a class="jxr_linenumber" name="695" href="#695">695</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="696" href="#696">696</a> <em class="jxr_javadoccomment">         * @param string the attribute value</em>
<a class="jxr_linenumber" name="697" href="#697">697</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="698" href="#698">698</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAt(String string)
<a class="jxr_linenumber" name="699" href="#699">699</a>         {
<a class="jxr_linenumber" name="700" href="#700">700</a>             at = string;
<a class="jxr_linenumber" name="701" href="#701">701</a>         }
<a class="jxr_linenumber" name="702" href="#702">702</a> 
<a class="jxr_linenumber" name="703" href="#703">703</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="704" href="#704">704</a> <em class="jxr_javadoccomment">         * Returns the configuration object.</em>
<a class="jxr_linenumber" name="705" href="#705">705</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="706" href="#706">706</a> <em class="jxr_javadoccomment">         * @return the configuration</em>
<a class="jxr_linenumber" name="707" href="#707">707</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="708" href="#708">708</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/Configuration.html">Configuration</a> getConfiguration()
<a class="jxr_linenumber" name="709" href="#709">709</a>         {
<a class="jxr_linenumber" name="710" href="#710">710</a>             <strong class="jxr_keyword">return</strong> configuration;
<a class="jxr_linenumber" name="711" href="#711">711</a>         }
<a class="jxr_linenumber" name="712" href="#712">712</a> 
<a class="jxr_linenumber" name="713" href="#713">713</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="714" href="#714">714</a> <em class="jxr_javadoccomment">         * Sets the configuration object. Note: Normally this method should be</em>
<a class="jxr_linenumber" name="715" href="#715">715</a> <em class="jxr_javadoccomment">         * named {@code setConfiguration()}, but the name</em>
<a class="jxr_linenumber" name="716" href="#716">716</a> <em class="jxr_javadoccomment">         * {@code addConfiguration()} is required by some of the digester</em>
<a class="jxr_linenumber" name="717" href="#717">717</a> <em class="jxr_javadoccomment">         * rules.</em>
<a class="jxr_linenumber" name="718" href="#718">718</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="719" href="#719">719</a> <em class="jxr_javadoccomment">         * @param config the configuration to set</em>
<a class="jxr_linenumber" name="720" href="#720">720</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="721" href="#721">721</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addConfiguration(<a href="../../../../org/apache/commons/configuration/Configuration.html">Configuration</a> config)
<a class="jxr_linenumber" name="722" href="#722">722</a>         {
<a class="jxr_linenumber" name="723" href="#723">723</a>             configuration = config;
<a class="jxr_linenumber" name="724" href="#724">724</a>         }
<a class="jxr_linenumber" name="725" href="#725">725</a>     }
<a class="jxr_linenumber" name="726" href="#726">726</a> 
<a class="jxr_linenumber" name="727" href="#727">727</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="728" href="#728">728</a> <em class="jxr_javadoccomment">     * An internally used helper class for constructing the composite</em>
<a class="jxr_linenumber" name="729" href="#729">729</a> <em class="jxr_javadoccomment">     * configuration object.</em>
<a class="jxr_linenumber" name="730" href="#730">730</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="731" href="#731">731</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">ConfigurationBuilder</a>
<a class="jxr_linenumber" name="732" href="#732">732</a>     {
<a class="jxr_linenumber" name="733" href="#733">733</a>         <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Stores the composite configuration.*/</em>
<a class="jxr_linenumber" name="734" href="#734">734</a>         <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/commons/configuration/CompositeConfiguration.html">CompositeConfiguration</a> config;
<a class="jxr_linenumber" name="735" href="#735">735</a> 
<a class="jxr_linenumber" name="736" href="#736">736</a>         <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Stores a collection with the configs from the additional section.*/</em>
<a class="jxr_linenumber" name="737" href="#737">737</a>         <strong class="jxr_keyword">private</strong> Collection&lt;AdditionalConfigurationData&gt; additionalConfigs;
<a class="jxr_linenumber" name="738" href="#738">738</a> 
<a class="jxr_linenumber" name="739" href="#739">739</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="740" href="#740">740</a> <em class="jxr_javadoccomment">         * Creates a new instance of {@code ConfigurationBuilder}.</em>
<a class="jxr_linenumber" name="741" href="#741">741</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="742" href="#742">742</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">ConfigurationBuilder</a>()
<a class="jxr_linenumber" name="743" href="#743">743</a>         {
<a class="jxr_linenumber" name="744" href="#744">744</a>             config = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/CompositeConfiguration.html">CompositeConfiguration</a>();
<a class="jxr_linenumber" name="745" href="#745">745</a>             additionalConfigs = <strong class="jxr_keyword">new</strong> LinkedList&lt;AdditionalConfigurationData&gt;();
<a class="jxr_linenumber" name="746" href="#746">746</a>         }
<a class="jxr_linenumber" name="747" href="#747">747</a> 
<a class="jxr_linenumber" name="748" href="#748">748</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="749" href="#749">749</a> <em class="jxr_javadoccomment">         * Adds a new configuration to this object. This method is called by</em>
<a class="jxr_linenumber" name="750" href="#750">750</a> <em class="jxr_javadoccomment">         * Digester.</em>
<a class="jxr_linenumber" name="751" href="#751">751</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="752" href="#752">752</a> <em class="jxr_javadoccomment">         * @param conf the configuration to be added</em>
<a class="jxr_linenumber" name="753" href="#753">753</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="754" href="#754">754</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addConfiguration(<a href="../../../../org/apache/commons/configuration/Configuration.html">Configuration</a> conf)
<a class="jxr_linenumber" name="755" href="#755">755</a>         {
<a class="jxr_linenumber" name="756" href="#756">756</a>             config.addConfiguration(conf);
<a class="jxr_linenumber" name="757" href="#757">757</a>         }
<a class="jxr_linenumber" name="758" href="#758">758</a> 
<a class="jxr_linenumber" name="759" href="#759">759</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="760" href="#760">760</a> <em class="jxr_javadoccomment">         * Adds information about an additional configuration. This method is</em>
<a class="jxr_linenumber" name="761" href="#761">761</a> <em class="jxr_javadoccomment">         * called by Digester.</em>
<a class="jxr_linenumber" name="762" href="#762">762</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="763" href="#763">763</a> <em class="jxr_javadoccomment">         * @param data the data about the additional configuration</em>
<a class="jxr_linenumber" name="764" href="#764">764</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="765" href="#765">765</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addAdditionalConfig(<a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">AdditionalConfigurationData</a> data)
<a class="jxr_linenumber" name="766" href="#766">766</a>         {
<a class="jxr_linenumber" name="767" href="#767">767</a>             additionalConfigs.add(data);
<a class="jxr_linenumber" name="768" href="#768">768</a>         }
<a class="jxr_linenumber" name="769" href="#769">769</a> 
<a class="jxr_linenumber" name="770" href="#770">770</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="771" href="#771">771</a> <em class="jxr_javadoccomment">         * Returns the final composite configuration.</em>
<a class="jxr_linenumber" name="772" href="#772">772</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="773" href="#773">773</a> <em class="jxr_javadoccomment">         * @return the final configuration object</em>
<a class="jxr_linenumber" name="774" href="#774">774</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="775" href="#775">775</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/CompositeConfiguration.html">CompositeConfiguration</a> getConfiguration()
<a class="jxr_linenumber" name="776" href="#776">776</a>         {
<a class="jxr_linenumber" name="777" href="#777">777</a>             <strong class="jxr_keyword">if</strong> (!additionalConfigs.isEmpty())
<a class="jxr_linenumber" name="778" href="#778">778</a>             {
<a class="jxr_linenumber" name="779" href="#779">779</a>                 <a href="../../../../org/apache/commons/configuration/Configuration.html">Configuration</a> unionConfig = createAdditionalConfiguration(additionalConfigs);
<a class="jxr_linenumber" name="780" href="#780">780</a>                 <strong class="jxr_keyword">if</strong> (unionConfig != <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="781" href="#781">781</a>                 {
<a class="jxr_linenumber" name="782" href="#782">782</a>                     addConfiguration(unionConfig);
<a class="jxr_linenumber" name="783" href="#783">783</a>                 }
<a class="jxr_linenumber" name="784" href="#784">784</a>                 additionalConfigs.clear();
<a class="jxr_linenumber" name="785" href="#785">785</a>             }
<a class="jxr_linenumber" name="786" href="#786">786</a> 
<a class="jxr_linenumber" name="787" href="#787">787</a>             <strong class="jxr_keyword">return</strong> config;
<a class="jxr_linenumber" name="788" href="#788">788</a>         }
<a class="jxr_linenumber" name="789" href="#789">789</a> 
<a class="jxr_linenumber" name="790" href="#790">790</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="791" href="#791">791</a> <em class="jxr_javadoccomment">         * Creates a configuration object with the union of all properties</em>
<a class="jxr_linenumber" name="792" href="#792">792</a> <em class="jxr_javadoccomment">         * defined in the &lt;code&gt;&amp;lt;additional&amp;gt;&lt;/code&gt; section. This</em>
<a class="jxr_linenumber" name="793" href="#793">793</a> <em class="jxr_javadoccomment">         * implementation returns a {@code HierarchicalConfiguration}</em>
<a class="jxr_linenumber" name="794" href="#794">794</a> <em class="jxr_javadoccomment">         * object.</em>
<a class="jxr_linenumber" name="795" href="#795">795</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="796" href="#796">796</a> <em class="jxr_javadoccomment">         * @param configs a collection with</em>
<a class="jxr_linenumber" name="797" href="#797">797</a> <em class="jxr_javadoccomment">         * {@code AdditionalConfigurationData} objects</em>
<a class="jxr_linenumber" name="798" href="#798">798</a> <em class="jxr_javadoccomment">         * @return the union configuration (can be &lt;b&gt;null&lt;/b&gt;)</em>
<a class="jxr_linenumber" name="799" href="#799">799</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="800" href="#800">800</a>         <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/commons/configuration/Configuration.html">Configuration</a> createAdditionalConfiguration(Collection&lt;AdditionalConfigurationData&gt; configs)
<a class="jxr_linenumber" name="801" href="#801">801</a>         {
<a class="jxr_linenumber" name="802" href="#802">802</a>             <a href="../../../../org/apache/commons/configuration/HierarchicalConfiguration.html">HierarchicalConfiguration</a> result = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/HierarchicalConfiguration.html">HierarchicalConfiguration</a>();
<a class="jxr_linenumber" name="803" href="#803">803</a> 
<a class="jxr_linenumber" name="804" href="#804">804</a>             <strong class="jxr_keyword">for</strong> (AdditionalConfigurationData cdata : configs)
<a class="jxr_linenumber" name="805" href="#805">805</a>             {
<a class="jxr_linenumber" name="806" href="#806">806</a>                 result.addNodes(cdata.getAt(),
<a class="jxr_linenumber" name="807" href="#807">807</a>                 createRootNode(cdata).getChildren());
<a class="jxr_linenumber" name="808" href="#808">808</a>             }
<a class="jxr_linenumber" name="809" href="#809">809</a> 
<a class="jxr_linenumber" name="810" href="#810">810</a>             <strong class="jxr_keyword">return</strong> result.isEmpty() ? <strong class="jxr_keyword">null</strong> : result;
<a class="jxr_linenumber" name="811" href="#811">811</a>         }
<a class="jxr_linenumber" name="812" href="#812">812</a> 
<a class="jxr_linenumber" name="813" href="#813">813</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="814" href="#814">814</a> <em class="jxr_javadoccomment">         * Creates a configuration root node for the specified configuration.</em>
<a class="jxr_linenumber" name="815" href="#815">815</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="816" href="#816">816</a> <em class="jxr_javadoccomment">         * @param cdata the configuration data object</em>
<a class="jxr_linenumber" name="817" href="#817">817</a> <em class="jxr_javadoccomment">         * @return a root node for this configuration</em>
<a class="jxr_linenumber" name="818" href="#818">818</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="819" href="#819">819</a>         <strong class="jxr_keyword">private</strong> HierarchicalConfiguration.Node createRootNode(<a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">AdditionalConfigurationData</a> cdata)
<a class="jxr_linenumber" name="820" href="#820">820</a>         {
<a class="jxr_linenumber" name="821" href="#821">821</a>             <strong class="jxr_keyword">if</strong> (cdata.getConfiguration() instanceof HierarchicalConfiguration)
<a class="jxr_linenumber" name="822" href="#822">822</a>             {
<a class="jxr_linenumber" name="823" href="#823">823</a>                 <em class="jxr_comment">// we can directly use this configuration's root node</em>
<a class="jxr_linenumber" name="824" href="#824">824</a>                 <strong class="jxr_keyword">return</strong> ((HierarchicalConfiguration) cdata.getConfiguration()).getRoot();
<a class="jxr_linenumber" name="825" href="#825">825</a>             }
<a class="jxr_linenumber" name="826" href="#826">826</a>             <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="827" href="#827">827</a>             {
<a class="jxr_linenumber" name="828" href="#828">828</a>                 <em class="jxr_comment">// transform configuration to a hierarchical root node</em>
<a class="jxr_linenumber" name="829" href="#829">829</a>                 <a href="../../../../org/apache/commons/configuration/HierarchicalConfiguration.html">HierarchicalConfiguration</a> hc = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/configuration/HierarchicalConfiguration.html">HierarchicalConfiguration</a>();
<a class="jxr_linenumber" name="830" href="#830">830</a>                 ConfigurationUtils.copy(cdata.getConfiguration(), hc);
<a class="jxr_linenumber" name="831" href="#831">831</a>                 <strong class="jxr_keyword">return</strong> hc.getRoot();
<a class="jxr_linenumber" name="832" href="#832">832</a>             }
<a class="jxr_linenumber" name="833" href="#833">833</a>         }
<a class="jxr_linenumber" name="834" href="#834">834</a>     }
<a class="jxr_linenumber" name="835" href="#835">835</a> 
<a class="jxr_linenumber" name="836" href="#836">836</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="837" href="#837">837</a> <em class="jxr_javadoccomment">     * A special implementation of Digester's {@code CallMethodRule} that</em>
<a class="jxr_linenumber" name="838" href="#838">838</a> <em class="jxr_javadoccomment">     * is internally used for calling a file configuration's {@code load()}</em>
<a class="jxr_linenumber" name="839" href="#839">839</a> <em class="jxr_javadoccomment">     * method. This class differs from its ancestor that it catches all occurring</em>
<a class="jxr_linenumber" name="840" href="#840">840</a> <em class="jxr_javadoccomment">     * exceptions when the specified method is called. It then checks whether</em>
<a class="jxr_linenumber" name="841" href="#841">841</a> <em class="jxr_javadoccomment">     * for the corresponding configuration the optional attribute is set. If</em>
<a class="jxr_linenumber" name="842" href="#842">842</a> <em class="jxr_javadoccomment">     * this is the case, the exception will simply be ignored.</em>
<a class="jxr_linenumber" name="843" href="#843">843</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="844" href="#844">844</a> <em class="jxr_javadoccomment">     * @since 1.4</em>
<a class="jxr_linenumber" name="845" href="#845">845</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="846" href="#846">846</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">CallOptionalMethodRule</a> <strong class="jxr_keyword">extends</strong> CallMethodRule
<a class="jxr_linenumber" name="847" href="#847">847</a>     {
<a class="jxr_linenumber" name="848" href="#848">848</a>         <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> A flag whether the optional attribute is set for this node. */</em>
<a class="jxr_linenumber" name="849" href="#849">849</a>         <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> optional;
<a class="jxr_linenumber" name="850" href="#850">850</a> 
<a class="jxr_linenumber" name="851" href="#851">851</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="852" href="#852">852</a> <em class="jxr_javadoccomment">         * Creates a new instance of {@code CallOptionalMethodRule} and</em>
<a class="jxr_linenumber" name="853" href="#853">853</a> <em class="jxr_javadoccomment">         * sets the name of the method to invoke.</em>
<a class="jxr_linenumber" name="854" href="#854">854</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="855" href="#855">855</a> <em class="jxr_javadoccomment">         * @param methodName the name of the method</em>
<a class="jxr_linenumber" name="856" href="#856">856</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="857" href="#857">857</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/commons/configuration/ConfigurationFactory.html">CallOptionalMethodRule</a>(String methodName)
<a class="jxr_linenumber" name="858" href="#858">858</a>         {
<a class="jxr_linenumber" name="859" href="#859">859</a>             <strong class="jxr_keyword">super</strong>(methodName);
<a class="jxr_linenumber" name="860" href="#860">860</a>         }
<a class="jxr_linenumber" name="861" href="#861">861</a> 
<a class="jxr_linenumber" name="862" href="#862">862</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="863" href="#863">863</a> <em class="jxr_javadoccomment">         * Checks if the optional attribute is set.</em>
<a class="jxr_linenumber" name="864" href="#864">864</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="865" href="#865">865</a> <em class="jxr_javadoccomment">         * @param attrs the attributes</em>
<a class="jxr_linenumber" name="866" href="#866">866</a> <em class="jxr_javadoccomment">         * @throws Exception if an error occurs</em>
<a class="jxr_linenumber" name="867" href="#867">867</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="868" href="#868">868</a>         @Override
<a class="jxr_linenumber" name="869" href="#869">869</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> begin(Attributes attrs) <strong class="jxr_keyword">throws</strong> Exception
<a class="jxr_linenumber" name="870" href="#870">870</a>         {
<a class="jxr_linenumber" name="871" href="#871">871</a>             optional = attrs.getValue(ATTR_OPTIONAL) != <strong class="jxr_keyword">null</strong>
<a class="jxr_linenumber" name="872" href="#872">872</a>                     &amp;&amp; PropertyConverter.toBoolean(
<a class="jxr_linenumber" name="873" href="#873">873</a>                             attrs.getValue(ATTR_OPTIONAL)).booleanValue();
<a class="jxr_linenumber" name="874" href="#874">874</a>             <strong class="jxr_keyword">super</strong>.begin(attrs);
<a class="jxr_linenumber" name="875" href="#875">875</a>         }
<a class="jxr_linenumber" name="876" href="#876">876</a> 
<a class="jxr_linenumber" name="877" href="#877">877</a>         <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="878" href="#878">878</a> <em class="jxr_javadoccomment">         * Calls the method. If the optional attribute was set, occurring</em>
<a class="jxr_linenumber" name="879" href="#879">879</a> <em class="jxr_javadoccomment">         * exceptions will be ignored.</em>
<a class="jxr_linenumber" name="880" href="#880">880</a> <em class="jxr_javadoccomment">         *</em>
<a class="jxr_linenumber" name="881" href="#881">881</a> <em class="jxr_javadoccomment">         * @throws Exception if an error occurs</em>
<a class="jxr_linenumber" name="882" href="#882">882</a> <em class="jxr_javadoccomment">         */</em>
<a class="jxr_linenumber" name="883" href="#883">883</a>         @Override
<a class="jxr_linenumber" name="884" href="#884">884</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> end() <strong class="jxr_keyword">throws</strong> Exception
<a class="jxr_linenumber" name="885" href="#885">885</a>         {
<a class="jxr_linenumber" name="886" href="#886">886</a>             <strong class="jxr_keyword">try</strong>
<a class="jxr_linenumber" name="887" href="#887">887</a>             {
<a class="jxr_linenumber" name="888" href="#888">888</a>                 <strong class="jxr_keyword">super</strong>.end();
<a class="jxr_linenumber" name="889" href="#889">889</a>             }
<a class="jxr_linenumber" name="890" href="#890">890</a>             <strong class="jxr_keyword">catch</strong> (Exception ex)
<a class="jxr_linenumber" name="891" href="#891">891</a>             {
<a class="jxr_linenumber" name="892" href="#892">892</a>                 <strong class="jxr_keyword">if</strong> (optional)
<a class="jxr_linenumber" name="893" href="#893">893</a>                 {
<a class="jxr_linenumber" name="894" href="#894">894</a>                     log.warn(<span class="jxr_string">"Could not create optional configuration!"</span>, ex);
<a class="jxr_linenumber" name="895" href="#895">895</a>                 }
<a class="jxr_linenumber" name="896" href="#896">896</a>                 <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="897" href="#897">897</a>                 {
<a class="jxr_linenumber" name="898" href="#898">898</a>                     <strong class="jxr_keyword">throw</strong> ex;
<a class="jxr_linenumber" name="899" href="#899">899</a>                 }
<a class="jxr_linenumber" name="900" href="#900">900</a>             }
<a class="jxr_linenumber" name="901" href="#901">901</a>         }
<a class="jxr_linenumber" name="902" href="#902">902</a>     }
<a class="jxr_linenumber" name="903" href="#903">903</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

